home *** CD-ROM | disk | FTP | other *** search
/ EnigmA Amiga Run 1996 June / EnigmA AMIGA RUN 08 (1996)(G.R. Edizioni)(IT)[!][issue 1996-06][EARSAN CD VII].iso / earcd / comm2 / xqm.lha / docs / XQM.doc
Text File  |  1995-08-22  |  8KB  |  201 lines
  1. $VER: XQmanager DOC XfreqQ Queue Management Tool  Williamson
  2.  
  3.     XQM, XQManager is copyright (c) 1995 by Robert Williamson
  4.     All Rights Reserved
  5.  
  6.     XQmanager  is  a  GUI based tool for viewing, editing and managing your
  7.   queue.  If your mailer doesn't use xferq.library for outbound management,
  8.   you should bug the author to add support.
  9.  
  10.     XQManager  is  the  only  tool  that allows editing the queue to change
  11.   destination   address,   transmitted   filename   (AsName)  priority  and
  12.   disposition.   Changes  can  be  applied  to  a  single  file, a group of
  13.   selected  files,  or  a group of files matching a pattern you provide.  
  14.  
  15.   Requires:
  16.       WB 2.11
  17.       a polling script named DIAL
  18.  
  19.       rexxtricks.library 38.3
  20.           provides ListViews of all sites and of all files for a selected
  21.           site.
  22.  
  23.       rexxreqtools.library and reqtools.library
  24.           provides string and gadget requesters.
  25.  
  26.       rexxdossupport.library 2.3
  27.           provides pattern matching 
  28.           (I've not tested the similar function in rexxtricks.library)
  29.  
  30.       xferq.library v1.9
  31.  
  32.   Functions:
  33.       Help Window
  34.       Show sites
  35.       Scan Site Queue
  36.       Scan Site's Queue
  37.       Dial site
  38.       Show queue for site
  39.       Remove site and all it's files from queue
  40.       Add new site and file to queue
  41.       ReRoute queued file(s) to another site
  42.       Add file(s) to site's queue
  43.       Remove one or more files from site's queue
  44.       Change file priority for one or more files to Crash or Hold
  45.       Globally Change ASNAME, numeric priority, or disposition 
  46.       for one or more files
  47.  
  48.     Since the viewlist is not dynamic, it is not updated if other processes
  49.   add  or  remove sites or files from the queue.  When a gadget is hit, the
  50.   viewlist  disappears  and  is  updated  after  the  selected  function is
  51.   completed.   The  Scan  and  ReScan commands also allow one to update the
  52.   current viewlist at any time.
  53.  
  54.  
  55.     XQM  checks  ENV:XQM  to see if debug mode is on.  If ENV:XQM is set to
  56.   DEBUG, certain debugging information is presented in the console.  Output
  57.   is  also  changed  somewhat,  with the titlebar and contents of the files
  58.   viewlist presented in a more technical manner.
  59.  
  60.   SITES:
  61.     The SITES viewlist displays all sites in the queue, the number of files
  62.   queued  per site and the maximum priority in the site queue.  The list is
  63.   sorted  by  address.   The  value  of  your  default  address  as  stored
  64.   XFERQ:hostaddr is displayed in the titlebar.
  65.  
  66.     An  asterix  '*'  following  the  priority  indicates  that the site is
  67.   ONLINE and a session is in progress.
  68.  
  69.     Available Gadgets:
  70.     Search  
  71.     View  Add  Kill  Dial  Scan  Help  Quit
  72.  
  73.         Search  - for pattern you define in string gadget
  74.         View    - show queue for selected site
  75.         Add     - add one or more files to the selected site or
  76.                   add a new site if none selected and queue one
  77.                    or more files.
  78.         Kill    - remove selected site from the queue
  79.         Dial    - Call selected site
  80.         Scan    - Scan and display sites
  81.         Help    - short help
  82.  
  83.     Double-clicking  on  a  site  entry  is equivalent to a single-clicking
  84.   (select) on a site entry and then the View gadget.
  85.  
  86.     The  FILES viewlist shows each file queued for the selected site, along
  87.   with the priority and disposition of each file.  Disposition is displayed
  88.   in  two  ways,  as  a letter code and in binary.  Queue control flags are
  89.   also displayed.  The list is sorted by priority. The address is displayed
  90.   in the titlebar.
  91.  
  92.     Both  the  contents  of  the titlebar and the information presented for
  93.   each  file in the queue depends upon the setting of the XQM environmental
  94.   variable.
  95.  
  96.   
  97.     TitleBar with ENV:XQM set to DEBUG
  98.     titlebar:
  99.       Files   site address              AsName      Pri/Stat/Flag
  100.     entry:
  101.       FULLNAME                          ASNAME      PRI STATUS FLAGS
  102.  
  103.       If a file is currently being sent, STATUS will be equal to 2.
  104.       FLAGS is the numeric value of the disposition and queue control flags.
  105.       See FLAGS and STATUS section for values.
  106.  
  107.     ENV:XQM not set to DEBUG
  108.     titlebar:
  109.       Files   site address              AsName      Pri Disp
  110.     entry:
  111.       FULLNAME                          ASNAME      PRI DISP BITS
  112.   
  113.       DISP  is a one or two letter code represent the disposition and queue
  114.       control FLAGS value.  These codes are common to all XferQ utilities.
  115.       BITS  is  the binary representation of the FLAGS value.  
  116.       If  a  file  is  currently  being sent, BITS will be in BOLD.  Do NOT
  117.       attempt to Edit, Kill, Crash or Hold a file being sent.
  118.  
  119.  
  120.     Available Gadgets:
  121.     All           Pattern           Toggle          None
  122.     Search
  123.     ReScan  Add  Kill  Crash  Hold  Edit   Sites  Help  Quit
  124.  
  125.         All     - select all entries
  126.         Pattern - select all entries matching pattern in search string
  127.                   gadget
  128.         Toggle  - select unselected and de-select selected
  129.         None    - clear all selections
  130.         Search  - for pattern you define in string gadget
  131.  
  132.         ReScan  - rescan and display site's queue
  133.         Add     - Add one or more files to the site's queue
  134.         Sites   - show sites in queue
  135.  
  136.         Multi-Select applies to the following. Hold the SHIFT key while
  137.         selecting multiple files.
  138.  
  139.         Kill    - Remove selected file(s) from site's queue
  140.         Crash   - change selected file(s) to CRASH
  141.         Hold    - change selected file(s) to HOLD
  142.         Edit    - change address, asname, priority or
  143.                   disposition for selected file(s)
  144.                   The value for the selected parameter is applied to
  145.                   ALL selected files, EXCEPT for ASNAME.
  146.                   If REROUTING (Edit Address) and the asname is ARCMAIL, 
  147.                   you will be prompted for a new ASNAME.
  148.         Help    - short help
  149.  
  150.     Double-clicking  on  a  FILE entry  is equivalent to a single-clicking
  151.   (select)  on a FILE entry and then the RESCAN gadget.  Probably not what
  152.   you wanted.  :)
  153.  
  154.                            *** W A R N I N G ***
  155.     I have encountered strange behaviour and the occasional guru when using
  156.     the  ListView  PATTERN gadget with an EMPTY search gadget.  Use at your
  157.     own risk, you have been warned.
  158.                            *** W A R N I N G ***
  159.  
  160.  
  161.   Notes:
  162.  
  163.     DIAL script:
  164.       If  you  have  a  command  or script named DIAL on the path, the Dial
  165.     gadget  will  execute it when clicked with the FQFA address of the site
  166.     selected as a parameter.
  167.  
  168.  
  169.   Tech:
  170.     XQmanager  should  not  be  considered  an  example  of  'proper' xferq
  171.   programming but rather of 'safe' xferq programming.  Xferq rexx functions
  172.   which have been shown to be problematic are avoided.  In particular, none
  173.   of  the functions to modify work are used.  Instead, files are completely
  174.   removed from the queue and then re-added with the changed attributes.
  175.  
  176.  
  177.     STATUS:
  178.       0 - UNSENT          - files has not been sent
  179.       1 - SENT            - file has been sent, but not yet 
  180.                             removed from queue (rare to see this)
  181.       2 - INTRANSIT       - file is being sent
  182.  
  183.  
  184.  
  185.     FLAGS   CODES
  186.                           Disposition flags    
  187.       0       L           - do nothing after sending
  188.       1       D           - Delete file after sending
  189.       2       T           - Truncate file after sending
  190.  
  191.                           Queue Control Flags  
  192.       4       I           - Send only if session currently up
  193.                             file was queued for onlin esite by a 
  194.                             request handler or robot
  195.       8       A           - Send later, Make eligible after session
  196.                             goes down (after site hangs up)
  197.      16       K           - execute disposition if sent, 
  198.                             ie: DO NOT Delete if XQ_DELETE+XQ_IMMEDIATE
  199.                             and file not sent
  200.  
  201.